The following methods are included in the CxDialogs library. Use the Dialogs methods to invoke a CygNet dialog without importing the library. To use the methods in other environments, create a COM component from the Dialogs library.
Dialogs methods include the following:
The ShowDataGroupDialog method shows the Data Group dialog box. Also see CxScript.GlobalFunctions.ShowDataGroupDialog.
ShowDataGroupDialog(UisOrDdsSiteService As String, FacilityId As String, DataGroupType As String, Ordinal As Integer)
| Parameter | Required | Description |
|---|---|---|
|
UisOrDdsSiteService |
Yes |
The name of a valid UIS or DDS from which to get information , in Site.Service format. |
|
FacilityId |
Yes |
A valid facility ID. |
|
DataGroupType |
Yes |
The Data Group Type of an existing data group. |
|
Ordinal |
Yes |
The ordinal number corresponding to the exact data group to show. This is helpful if there are more than one data groups of the same type. |
Example
The following example illustrates three ways to call this method. The first two methods display Discrete Output data groups, but the first method shows Ordinal 4 and the second shows Ordinal 5. The third method shows the properties dialog box for TESTMETER because no Data Group Type is specified.
|
Sub dataGrpDO4() 'Shows the Discrete Output data group with an ordinal of 4 ShowDataGroupDialog "CYGDEMO.UIS", "TESTMETER", "DO", 4 End Sub
Sub dataGrpDO5() 'Shows the Discrete Output data group with an ordinal of 5 ShowDataGroupDialog "CYGDEMO.UIS", "TESTMETER", "DO", 5 End Sub |
The ShowFacilityRulesDialog method displays the Facility Rules dialog box. Also see CxScript.GlobalFunctions.ShowFacilityRulesDialog.
ShowFacilityRulesDialog(InRules As String) As String
| Parameter | Required | Description |
|---|---|---|
|
InRules |
No |
An optional parameter allowing the input of human-readable text or XML to initialize the filter in the dialog box. If this parameter is not specified, the dialog box will not contain any filters upon initialization. |
This method will return the Facility Rule Filter XML created by the dialog box.
The following is an example of a Facility Rule Filter XML which filters all facilities where facility_category = "GENFAC" AND facility_siteservice = "CYGDEMO.UIS".
|
<ExportedRules exportTime="9/24/2011 07:37:46.621" ruleDataIdentifier="FAC Rules"> <Rules enabled="true" inverted="false" op="1" name=""> <Rule enabled="true" name="" referenceAttr="0" compareToType="0" externalData="" value="GENFAC" operator="=" qualifier="Case Insensitive"> <compareItem attr="facility_category"/> </Rule> <Rule enabled="true" name="" referenceAttr="0" compareToType="0" externalData="" value="CYGDEMO.UIS" operator="=" qualifier="Case Insensitive"> <compareItem attr="facility_siteservice"/> </Rule> </Rules> </ExportedRules> |
Example
The following example launches the Facility Rules dialog box and displays the generated rules in a message box.
|
Sub Dim Dialogs Set Dialogs = CreateObject("CxDialogs.Dialogs")
Dim strRules strRules = Dialogs.ShowFacilityRulesDialog("")
MsgBox strRules End Sub |
The ShowFacilityRulesDialogSimple method displays the Facility Rules dialog box. The optional InRules parameter allows both "simple" human-readable text and XML as the input to initialize the filter. The method will also output only human-readable text. Also see CxScript.GlobalFunctions.ShowFacilityRulesDialogSimple.
Notes:
This function differs from ShowFacilityRulesDialog only in that it allows input and output of simplified text. The Facility Rules dialog box will look the same regardless of the function used for invocation.
The human-readable text can be used in the ReferenceFacility property for any CygNet-aware Studio tool.
ShowFacilityRulesDialogSimple(InRules As String) As String
| Parameter | Required | Description |
|---|---|---|
|
InRules |
No |
An optional parameter allowing the input of human-readable text or XML to initialize the filter in the dialog box. If this parameter is not specified, the dialog box will not contain any filters upon initialization. |
This method will return the human-readable filter text created by the dialog box.
The following is an example of a facility rule filter input in text format which filters all facilities where facility_id = "TANK1" OR facility_id = "TANK2".
|
facility_id = ToCaseInsensitive('TANK1') OR facility_id = ToCaseInsensitive('TANK2') |
Example
The following example launches the Facility Rules dialog box and displays the generated rules in a message box.
|
Sub Dim Dialogs Set Dialogs = CreateObject("CxDialogs.Dialogs")
Dim strRules strRules = Dialogs.ShowFacilityRulesDialogSimple("")
MsgBox strRules End Sub |
The ShowRelativeTimeDialog method displays the Relative Time dialog box. Also see CxScript.GlobalFunctions.ShowRelativeTimeDialog.
ShowRelativeTimeDialog(InTime As String) As String
| Parameter | Required | Description |
|---|---|---|
|
InTime |
No |
An optional string used to initialize the Relative Time dialog box. This string can be in one of the following formats:
If this parameter is not specified, the dialog box will be initialized to the current date and time. |
This method will return a string representing the time configured in the dialog box. This format of this string will vary depending on the type of date time configured in the dialog box. If "Absolute Date/Time" is selected, the format of the returned string will be "(M)M/(D)D/YYYY (H)H:MM:SS". If "Relative Date/Time" is selected, the format of the returned string will be "y+/-# m+/-# d+/-# H+/-# M+/-# S+/-#" or "<Current>" if no relative date/time parameters are adjusted. If "Relative Day" is selected, the format of the returned string will be "T+/-#".
Example
The following example launches the Relative Time dialog box initialized to one year ago from the current time, and displays the result in a message box.
|
Sub Dim Dialogs Set Dialogs = CreateObject("CxDialogs.Dialogs")
Dim strTime strTime = Dialogs.ShowRelativeTimeDialog("y-1")
MsgBox strTime End Sub |
The ShowRollupConfigDialog method displays the History Rollup Configuration dialog box. Also see CxScript.GlobalFunctions.ShowRollupConfigDialog.
ShowRollupConfigDialog(TimeAdjustment As Variant, RollupType As Variant, RollupPeriod As Variant, Units As Variant, TopOfSubUnit As Variant)
| Parameter | Required | Description |
|---|---|---|
|
TimeAdjustment |
Yes |
The time adjustment returned by the dialog box. This string will match the date time configured in the Time Adjustment edit box. |
|
RollupType |
Yes |
The rollup type returned by the dialog box. This string will match the string selected in the Rollup Type combo box. |
|
RollupPeriod |
Yes |
The rollup period returned by the dialog box. This string will match the number configured in the Rollup Period edit box. |
|
Units |
Yes |
The Units returned by the dialog box. This string will match the string selected in the Units combo box. |
|
TopOfSubUnit |
Yes |
The top of subunit offset returned by the dialog box. This string will match the number configured in the Top of SubUnit edit box. |
Example
The following example launches the History Rollup Configuration dialog box and displays each returned parameter in a message box.
|
Sub Dim Dialogs Set Dialogs = CreateObject("CxDialogs.Dialogs")
Dim vTimeAdj, vType, vPeriod, vUnits, vTOS Dialogs.ShowRollupConfigDialog vTimeAdj, vType, vPeriod, vUnits, vTOS
MsgBox vTimeAdj MsgBox vType MsgBox vPeriod MsgBox vUnits MsgBox vTOS End Sub |
The ShowServiceInfoDialog method displays the Service Information dialog box for the specified site and service pair.
ShowServiceInfoDialog(DomainSiteService As String)
| Parameter | Required | Description |
|---|---|---|
|
DomainSiteService |
Yes |
A valid site and service, in "[domain]Site.Service" format, for which to show service information Note: If [domain] is not supplied, the ambient domain is searched. Default value is [blank] |
This method will return false if the supplied parameter is invalid.
Example
The following example launches the CygNet Service Information dialog box and displays the data for the chosen [Domain]Site.Service.
|
Sub Dim Dialogs Set Dialogs = CreateObject("CxDialogs.Dialogs")
Dialogs.ShowShowServiceInfoDialog "CYGDEMO.RSM" End Sub |
The ShowUisCmdAuxDialog method displays the UIS Command Auxiliary Information dialog box. Also see CxScript.GlobalFunctions.ShowUisCmdAuxDialog.
ShowUisCmdAuxDialog(UisOrDdsSiteService As String, FacilityId As String, UisCmdName As String) As Boolean
| Parameter | Required | Description |
|---|---|---|
|
UisOrDdsSiteService |
Yes |
The name of a valid UIS or DDS from which to get information , in Site.Service format. |
|
FacilityId |
Yes |
The facility ID for which to modify UIS command auxiliary information. |
|
UisCmdName |
Yes |
The name of the UIS command for which to modify auxiliary information. |
This method will return false if any of the supplied parameters are invalid.
Example
The following example launches the UIS Command Auxiliary Information dialog box.
|
Sub Dim Dialogs Set Dialogs = CreateObject("CxDialogs.Dialogs")
Dim vTimeAdj, vType, vPeriod, vUnits, vTOS Dialogs.ShowUisCmdAuxDialog "CYGDEMO.UIS", "FLOWAUTOAP15", "RTUCFGGET" End Sub |
The ShowUisCmdStateDialog method shows the UIS Command State dialog box. Also see CxScript.GlobalFunctions.ShowUisCmdStateDialog.
ShowUisCmdStateDialog(UisOrDdsSiteService As String, FacilityId As String, UisCmdName As String, ShowExecutionPrompt As Boolean) As Boolean
| Parameter | Required | Description |
|---|---|---|
|
UisOrDdsSiteService |
Yes |
The name of a valid UIS or DDS Site.Service for which to modify UIS command auxiliary information. |
|
FacilityId |
Yes |
A valid facility ID. |
|
UisCmdName |
Yes |
The name of a UIS Command in the FacilityId. |
|
ShowExecutionPrompt |
Yes |
Set to True to show a button to execute the UIS Command, set to False to hide the button. |
Return Value: A Boolean indicating whether the operation was successful. If ShowExecutionPrompt is set to False, this method will automatically return True.
Example
The following example shows the dialog box for the POLL command and is used to execute it.
|
Sub showCmdDialog() Dim bRet bRet = ShowUisCmdStateDialog ("CYGDEMO.UIS", "CYG_METER", "POLL", True) If bRet Then edtMessageBox.Text = "Successful execution" Else edtMessageBox.Text = "Error executing command" End If End Sub |
|
|
|
